[%#
  # IMPORTANT NOTE
  #   This documentation is generated automatically from source
  #   templates.  Any changes you make here may be lost.
  # 
  #   The 'docsrc' documentation source bundle is available for download
  #   from http://www.template-toolkit.org/docs.html and contains all
  #   the source templates, XML files, scripts, etc., from which the
  #   documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
        page = 'Plugin_Wrap'
%]
[%  WRAPPER toc;
	PROCESS tocitem 
	        title ="SYNOPSIS"
                subs  = [];
	PROCESS tocitem 
	        title ="DESCRIPTION"
                subs  = [];
	PROCESS tocitem 
	        title ="AUTHOR"
                subs  = [];
	PROCESS tocitem 
	        title ="VERSION"
                subs  = [];
	PROCESS tocitem 
	        title ="COPYRIGHT"
                subs  = [];
	PROCESS tocitem 
	        title ="SEE ALSO"
                subs  = [];
    END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
    title="SYNOPSIS"
-%]<pre>    [% tt_start_tag %] USE wrap [% tt_end_tag %]</pre>
<pre>    # call wrap subroutine
    [% tt_start_tag %] wrap(mytext, width, initial_tab,  subsequent_tab) [% tt_end_tag %]</pre>
<pre>    # or use wrap FILTER
    [% tt_start_tag %] mytext FILTER wrap(width, initital_tab, subsequent_tab) [% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
    title="DESCRIPTION"
-%]<p>
This plugin provides an interface to the Text::Wrap module which 
provides simple paragraph formatting.
</p>
<p>
It defines a 'wrap' subroutine which can be called, passing the input
text and further optional parameters to specify the page width (default:
72), and tab characters for the first and subsequent lines (no defaults).
</p>
<pre>    [% tt_start_tag %] USE wrap [% tt_end_tag %]</pre>
<pre>    [% tt_start_tag %] text = BLOCK [% tt_end_tag %]
    First, attach the transmutex multiplier to the cross-wired 
    quantum homogeniser.
    [% tt_start_tag %] END [% tt_end_tag %]</pre>
<pre>    [% tt_start_tag %] wrap(text, 40, '* ', '  ') [% tt_end_tag %]</pre>
<p>
Output:
</p>
<pre>    * First, attach the transmutex
      multiplier to the cross-wired quantum
      homogeniser.</pre>
<p>
It also registers a 'wrap' filter which accepts the same three optional 
arguments but takes the input text directly via the filter input.
</p>
<pre>    [% tt_start_tag %] FILTER bullet = wrap(40, '* ', '  ') -[% tt_end_tag %]
    First, attach the transmutex multiplier to the cross-wired quantum
    homogeniser.
    [% tt_start_tag %]- END [% tt_end_tag %]</pre>
<pre>    [% tt_start_tag %] FILTER bullet -[% tt_end_tag %]
    Then remodulate the shield to match the harmonic frequency, taking 
    care to correct the phase difference.
    [% tt_start_tag %] END [% tt_end_tag %]</pre>
<p>
Output:
</p>
<pre>    * First, attach the transmutex
      multiplier to the cross-wired quantum
      homogeniser.</pre>
<pre>    * Then remodulate the shield to match
      the harmonic frequency, taking 
      care to correct the phase difference.</pre>
[%- END %]
[% WRAPPER section
    title="AUTHOR"
-%]<p>
Andy Wardley &lt;abw@wardley.org&gt;
</p>
<p>
The Text::Wrap module was written by David Muir Sharnoff
&lt;muir@idiom.com&gt; with help from Tim Pierce and many
others.
</p>
[%- END %]
[% WRAPPER section
    title="VERSION"
-%]<p>
2.68, distributed as part of the
Template Toolkit version 2.19, released on 27 April 2007.
</p>
[%- END %]
[% WRAPPER section
    title="COPYRIGHT"
-%]<pre>  Copyright (C) 1996-2007 Andy Wardley.  All Rights Reserved.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
    title="SEE ALSO"
-%]<p>
[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('Text::Wrap', 'Text::Wrap') -%]
</p>
[%- END %]



